功能描述:新建一个边缘节点设备,返回新建设备的id, apiKey, 用于该设备的信息鉴权。
POST /api/v1/edgenode/pro
Body:
Name | Type | Description | Required |
---|---|---|---|
name | string | 边缘节点名称 | Yes |
description | string | 边缘节点描述 | No |
cpuType | int | CPU架构(0-ARM,1-ARM64,2-AMD64),默认是0 | No |
systemType | int | 系统类型(0-Linux) | No |
Body example:
{
"name": "edge_node",
"description": "",
"cpuType": 2,
"systemType": 0
}
cURL example:
curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/edgenode/pro?accessKeyId={accessKeyId}&signatureNonce=495&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "edge_node",
"description": "",
"cpuType": 2,
"systemType": 0
}'
Response data:
Name | Type | Description |
---|---|---|
id | int | 边缘节点ID |
apiKey | string | 边缘节点KEY |
Response example:
{
"success": true,
"code": 0,
"msg": "",
"data": {
"apiKey": "NGNlYTkxMDk1MDdjYWNkOGUyZjI=",
"id": 41
}
}
功能描述:指定一个边缘节点设备,对该设备的边缘节点部分属性进行更新。
PUT /api/v1/edgenode/pro/{deviceId}
Path:
Name | Type | Description | Required |
---|---|---|---|
deviceId | int | 边缘节点ID | Yes |
Body:
Name | Type | Description | Required |
---|---|---|---|
logEnable | int | 是否启用日志 (1:启用 / 0:不启用) | No |
logDay | int | 日志保存时长天数, 目前支持值 : 1, 7 , 30, 分别表示一天,一周,一月。 | No |
logLevel | int | 日志级别(日志等级:0-错误,1-警告,2-信息) | No |
dataSavePeriod | int | 数据存储周期 | No |
adminState | int | 启用状态 (0-启用,1-禁用) | No |
appVersion | string | 应用版本 | No |
cpuType | int | cpu类型(0-ARM,1-ARM64,2-AMD64) | No |
logLevel | int | 日志级别(日志等级:0-错误,1-警告,2-信息) | No |
description | string | 节点描述 | No |
name | string | 节点名称 | No |
nodeType | int | 节点类型(1-kubeedge) | No |
systemType | int | 系统类型(0-linux) | No |
Body example:
{
"cpuType": 2,
"description": "",
"logLevel": 2,
"adminState": 1,
"systemType": 0,
"nodeType": 1,
"logDay": 1,
"name": "edge_node1",
"logEnable": 0,
"dataSavePeriod": 0
}
cURL example:
curl --location --request PATCH '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/edgenode/pro/10000802?accessKeyId={accessKeyId}&signatureNonce=495&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}' \
--header 'Content-Type: application/json' \
--data-raw '{
"cpuType": 2,
"description": "",
"logLevel": 2,
"adminState": 1,
"systemType": 0,
"nodeType": 1,
"logDay": 1,
"name": "edge_node1",
"logEnable": 0,
"dataSavePeriod": 0
}'
Response example:
{
"success": true,
"code": 0,
"msg": "",
"data": 1
}
功能描述:查看边缘节点设备的边缘节点特征属性。
GET /api/v1/edgenode/pro/{deviceId}
Path:
Name | Type | Description | Required |
---|---|---|---|
deviceId | int | 边缘节点ID | Yes |
cURL example:
curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/edgenode/pro/10000803?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response data:
Name | Type | Description |
---|---|---|
id | int | 边缘节点ID |
logLevel | int | 日志级别(日志等级:0-错误,1-警告,2-信息) |
logEnable | int | 是否启用日志 (1:启用 / 0:不启用) |
logDay | int | 日志保存时长天数, 目前支持值 : 1, 7 , 30, 分别表示一天,一周,一月。 |
cpuType | int | cpu类型,0-ARM,1-ARM64,2-AMD64 |
systemType | int | 系统类型,0-linux |
dataSavePeriod | int | 数据存储周期 |
deployStatus | int | 部署状态,0-未部署,2-部署成功,3-部署失败 |
description | string | 描述 |
lastConnected | long | 最近上线时间 |
lastReported | long | 最近上报状态的时间 |
modified | long | 修改时间 |
name | string | 名称 |
nodeType | int | 节点类型,1-kubeedge |
operatingState | int | 上下线状态 0-disabled,1-enabled |
upgradeStatus | int | 升级状态,1-OK,2-FAIL,3-升级中 |
upgradeTime | long | 升级时间 |
userId | string | 用户ID |
Response example:
{
"code": 0,
"data": {
"hostName": "",
"appVersion": "",
"cpuType": 2,
"addresses": null,
"apiKey": "N2M3YmI2YzdiNDlhZDZmYmRlNmE=",
"upgradeTime": 0,
"operatingState": 0,
"containerRuntimeVersion": "",
"description": "",
"upgradeStatus": 1,
"logLevel": 2,
"lastConnected": 0,
"adminState": 1,
"systemType": 0,
"modified": 1596704396668,
"id": 10245695,
"created": 1596703316391,
"specification": "",
"nodeType": 1,
"userName": null,
"userId": "bb5f2d0f4fad4d2ab1897d3fdca7c5c3",
"logDay": 1,
"systemInfo": "",
"lastReported": 0,
"name": "edge_node2",
"logEnable": 0,
"dataSavePeriod": 0,
"deployStatus": 0
},
"msg": "成功",
"success": true
}
功能描述:边缘节点设备绑定一个或多个设备。
POST /api/v1/devices/gateway/associations
Query:
Name | Type | Description | Required |
---|---|---|---|
gatewayId | string | 边缘节点ID | Yes |
productId | int | 产品ID | Yes |
deviceIds | string | 关联设备ID列表,以逗号隔开 | Yes |
cURL example:
curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/devices/gateway/associations?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}&gatewayId=10000804&productId=10001&deviceIds=10000804,10000805' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response data:
Name | Type | Description |
---|---|---|
data | struct[] | 关联设备信息列表 |
Response data data的子对象结构体:
Name | Type | Description |
---|---|---|
deviceId | int | 关联设备ID |
parentId | int | 边缘节点ID |
productId | int | 产品ID |
masterKey | string | 产品KEY |
Response example:
{
"success": true,
"code": 0,
"msg": "",
"data": [
{
"deviceId": 10000201,
"parentId": 10000144,
"productId": 100150,
"masterKey": "ZjBiNDY0MTk4NzYwYmM2NThkNWI="
},
{
"deviceId": 10000196,
"parentId": 10000144,
"productId": 100150,
"masterKey": "ZjBiNDY0MTk4NzYwYmM2NThkNWI="
}
]
}
功能描述:删除某个边缘节点设备下的设备关联信息。
DELETE /api/v1/devices/gateway/associations
Query:
Name | Type | Description | Required |
---|---|---|---|
gatewayId | string | 边缘节点设备ID | Yes |
deviceIds | string | 关联设备ID列表,以逗号隔开 | Yes |
cURL example:
curl --location --request DELETE '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/devices/gateway/associations?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}&gatewayId=10000804&deviceIds=10000804,10000805' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response example:
{
"success": true,
"code": 0,
"msg": "",
"data": 1
}
功能描述:查询某个边缘节点设备下的设备配置信息。
GET /api/v1/devices/gateway/information/{gatewayId}
Path:
Name | Type | Description | Required |
---|---|---|---|
gatewayId | string | 边缘节点设备ID | Yes |
cURL example:
curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/devices/gateway/information/10000806?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response data:
Name | Type | Description |
---|---|---|
rulesCount | int | 场景联动数量 |
exportCount | int | 云消息数量 |
deviceCount | int | 子设备关联数量 |
channelCount | int | 通信通道数量 |
Response example:
{
"success": true,
"code": 0,
"msg": "",
"data":
{
"rulesCount": 12,
"exportCount": 11,
"deviceCount": 1,
"channelCount": 10
}
}
功能描述:查询边缘节点下所有关联边缘终端的信息。
GET /api/v1/devices/gateway/multi/{gatewayId}/{protocolType}
Path:
Name | Type | Description | Required |
---|---|---|---|
gatewayId | string | 边缘节点设备ID | Yes |
protocolType | int | 物模型协议 (1 : MQTT; 4 : Modbus; 5 : OPC UA; 7 : BACnet) | Yes |
cURL example:
curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/devices/gateway/multi/10000801/1?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response data:
Name | Type | Description |
---|---|---|
data | struct[] | 关联设备信息列表 |
Response data data的子对象结构体:
Name | Type | Description |
---|---|---|
Name | Type | Description |
created | long | 创建时间 |
description | string | 描述 |
adminState | int | 启用状态,0-禁用,1-启用,2-用户禁用 |
apiKey | string | 设备key |
connectGatewayId | string | 当前连接的边缘节点 |
encrypt | boolean | 是否加密,0:不加密,1:加密 |
name | string | 设备名 |
labels | string[] | 产品标签 |
id | int | 设备ID |
lastConnected | long | 最近上线时间 |
lastReported | long | 最近上报状态的时间 |
location | string | 位置 |
modified | long | 修改时间 |
operatingState | string | 上下线状态(0-disabled,1-enabled,2-gatewayenabled,3-未激活) |
parentId | int | 关联边缘节点ID |
userId | string | 用户ID |
protocolType | int | 协议类型,1:MQTT,2:LWM2M,3:TCP,4:Modbus,5:OPC UA |
productId | int | 产品ID |
Response example:
{
"success": true,
"code": 0,
"msg": "",
"data": [
{
"deviceId": 10000201,
"parentId": 10000144,
"productId": 100150,
"masterKey": "ZjBiNDY0MTk4NzYwYmM2NThkNWI="
},
{
"deviceId": 10000196,
"parentId": 10000144,
"productId": 100150,
"masterKey": "ZjBiNDY0MTk4NzYwYmM2NThkNWI="
}
]
}
功能描述:删除指定边缘节点。
DELETE /api/v1/edgenode/pro/{deviceId}
Path:
Name | Type | Description | Required |
---|---|---|---|
deviceId | string | 边缘节点ID | Yes |
cURL example:
curl --location --request DELETE '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/edgenode/pro/10000601?accessKeyId={accessKeyId}&signatureNonce=529&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response example:
{
"success": true,
"code": 0,
"msg": ""
}
功能描述:分页查询指定产品下的边缘节点,返回具体分页信息和节点列表。
GET /api/v1/edgenode/pro/page
Query:
Name | Type | Description | Required |
---|---|---|---|
pageSize | int | 分页大小 | Yes |
currentPage | int | 页码 | Yes |
name | string | 设备名称,前缀匹配 | No |
cURL example:
curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/edgenode/pro/page?accessKeyId={accessKeyId}&signatureNonce=529&signature={signature}&productId=10008&pageSize=10¤tPage=1' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response data:
Name | Type | Description |
---|---|---|
currentPage | int | 当前页码 |
pageSize | int | 每页条数 |
totalCount | long | 总条数 |
totalPage | int | 总页数 |
content | struct[] | 当前页内容 |
Response data content的子对象结构体:
Name | Type | Description |
---|---|---|
id | int | 边缘节点ID |
logLevel | int | 日志级别(日志等级:0-错误,1-警告,2-信息) |
logEnable | int | 是否启用日志 (1:启用 / 0:不启用) |
logDay | int | 日志保存时长天数, 目前支持值 : 1, 7 , 30, 分别表示一天,一周,一月。 |
cpuType | int | cpu类型,0-ARM,1-ARM64,2-AMD64 |
systemType | int | 系统类型,0-linux |
dataSavePeriod | int | 数据存储周期 |
deployStatus | int | 部署状态,0-未部署,2-部署成功,3-部署失败 |
description | string | 描述 |
lastConnected | long | 最近上线时间 |
lastReported | long | 最近上报状态的时间 |
modified | long | 修改时间 |
name | string | 名称 |
nodeType | int | 节点类型,1-kubeedge |
operatingState | int | 上下线状态 0-disabled,1-enabled |
upgradeStatus | int | 升级状态,1-OK,2-FAIL,3-升级中 |
upgradeTime | long | 升级时间 |
userId | string | 用户ID |
Response example:
{
"code": 0,
"data": {
"totalPage": 1,
"pageSize": 10,
"currentPage": 1,
"totalCount": 3,
"content": [
{
"appVersion": "",
"cpuType": 2,
"apiKey": "N2M3YmI2YzdiNDlhZDZmYmRlNmE=",
"upgradeTime": 0,
"operatingState": 0,
"created": 1596703316391,
"description": "",
"nodeType": 1,
"userName": null,
"userId": "bb5f2d0f4fad4d2ab1897d3fdca7c5c3",
"logDay": 1,
"upgradeStatus": 1,
"logLevel": 2,
"lastConnected": 0,
"lastReported": 0,
"adminState": 1,
"name": "edge_node2",
"systemType": 0,
"modified": 1596706530856,
"logEnable": 0,
"id": 10245695,
"dataSavePeriod": 0,
"deployStatus": 0
},
{
"appVersion": "",
"cpuType": 2,
"apiKey": "MjE1MTg1NDY3NjBhNmZjMThmMDk=",
"upgradeTime": 0,
"operatingState": 0,
"created": 1596703258194,
"description": "",
"nodeType": 1,
"userName": null,
"userId": "bb5f2d0f4fad4d2ab1897d3fdca7c5c3",
"logDay": 1,
"upgradeStatus": 1,
"logLevel": 2,
"lastConnected": 0,
"lastReported": 0,
"adminState": 1,
"name": "edge_node1",
"systemType": 0,
"modified": 1596703258194,
"logEnable": 0,
"id": 10245694,
"dataSavePeriod": 0,
"deployStatus": 0
},
{
"appVersion": "",
"cpuType": 2,
"apiKey": "ODI3M2QwYTM2MDUwMjdlOTI1MzI=",
"upgradeTime": 0,
"operatingState": 0,
"created": 1596703210553,
"description": "",
"nodeType": 1,
"userName": null,
"userId": "bb5f2d0f4fad4d2ab1897d3fdca7c5c3",
"logDay": 1,
"upgradeStatus": 1,
"logLevel": 2,
"lastConnected": 0,
"lastReported": 0,
"adminState": 1,
"name": "edge_node",
"systemType": 0,
"modified": 1596703210553,
"logEnable": 0,
"id": 10245693,
"dataSavePeriod": 0,
"deployStatus": 0
}
]
},
"msg": "成功",
"success": true
}
功能描述:提供批量启用或禁用指定边缘节点的能力。
PUT /api/v1/edgenode/pro/adminstate/multi
Query:
Name | Type | Description | Required |
---|---|---|---|
id | int[] | 批量节点ID | Yes |
adminState | int | 启用状态(0-禁用,1-启用) | Yes |
cURL example:
curl --location --request PATCH '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/edgenode/pro/adminstate/multi?accessKeyId={accessKeyId}&signatureNonce=495&signature={signature}&id=10245695,10245696&adminState=0' \
--header 'platform: 3' \
--header 'projectId: {projectId}' \
--header 'Content-Type: application/json'
Response example:
{
"code": 0,
"data": null,
"msg": "成功",
"success": true
}
功能描述:查询边缘节点已关联的边缘终端。
GET /api/v1/devices/subdevice/IN/page
Query:
Name | Type | Description | Required |
---|---|---|---|
currentPage | int | 当前页码,从1开始 | Yes |
pageSize | int | 分页大小,从1开始 | Yes |
deviceId | int | 设备,边缘节点或DTU设备的ID | No |
protocol | int | 子设备协议,1: MQTT, 4: Modbus, 5: OPC UA, 7: BACnet | Yes |
name | string | 子设备名,模糊查询 | No |
product | int | 产品ID | No |
adminState | int | 启用状态:0-全部,1-禁用,2-启用 | No |
operatingState | int | 在线状态(0:所有 / 1:离线 / 2:在线 / 3:未激活),当参数adminState=1时,该查询条件无意义 | No |
parentId | int | 边缘节点ID | Yes |
cURL example:
curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/devices/subdevice/IN/page?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}&parentId=10008&pageSize=10¤tPage=1&protocol=1' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response data:
Name | Type | Description |
---|---|---|
currentPage | int | 当前页码 |
pageSize | int | 每页条数 |
totalCount | long | 总条数 |
totalPage | int | 总页数 |
content | struct[] | 当前页内容 |
Response data content的子对象结构体:
Name | Type | Description |
---|---|---|
created | long | 创建时间 |
description | string | 描述 |
adminState | int | 启用状态,0-禁用,1-启用,2-用户禁用 |
apiKey | string | 设备key |
connectGatewayId | string | 当前连接的边缘节点 |
encrypt | boolean | 是否加密,0:不加密,1:加密 |
name | string | 设备名 |
labels | string[] | 产品标签 |
id | int | 设备ID |
lastConnected | long | 最近上线时间 |
lastReported | long | 最近上报状态的时间 |
location | string | 位置 |
modified | long | 修改时间 |
operatingState | string | 在线状态(-1:无在线状态 / 0:离线 / 1:设备在线 / 2:网关在线 / 3:未激活) |
parentId | int | 关联边缘节点ID |
userId | string | 用户ID |
protocolType | int | 协议类型,1:MQTT,2:LWM2M,3:TCP,4:Modbus,5:OPC UA |
productId | int | 产品ID |
Response example:
{
"data": {
"currentPage": 1,
"pageSize": 5,
"totalCount": 1,
"totalPage": 1,
"content": [
{
"id": 10000247,
"name": "strdddd",
"userId": null,
"productId": 100048,
"created": 1568801094160,
"modified": 1568801094160,
"description": "string",
"adminState": 1,
"operatingState": 0,
"labels": null,
"lastConnected": 0,
"lastReported": 0,
"location": null,
"apiKey": "YTE1NTBhZDlkOGI2ZTliNmE4ZjY=",
"protocolType": 4,
"connectGatewayId": "0",
"encrypt": false
}
]
},
"success": true,
"code": 0,
"msg": null
}
功能描述:查询边缘节点未关联的边缘终端。
GET /api/v1/devices/subdevice/NIN/page
Query:
Name | Type | Description | Required |
---|---|---|---|
currentPage | int | 当前页码,从1开始 | Yes |
pageSize | int | 分页大小,从1开始 | Yes |
deviceId | int | 设备,边缘节点或DTU设备的ID | No |
protocol | int | 子设备协议,1: MQTT, 4: Modbus, 5: OPC UA, 7: BACnet | No |
name | string | 子设备名,模糊查询 | No |
product | int | 产品ID | Yes |
adminState | int | 启用状态:0-全部,1-禁用,2-启用 | No |
operatingState | int | 在线状态(0:所有 / 1:离线 / 2:在线 / 3:未激活),当参数adminState=1时,该查询条件无意义 | No |
parentId | int | 边缘节点ID | Yes |
cURL example:
curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/devices/subdevice/NIN/page?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}&parentId=10008&pageSize=10¤tPage=1&protocol=1' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response data:
Name | Type | Description |
---|---|---|
currentPage | int | 当前页码 |
pageSize | int | 每页条数 |
totalCount | long | 总条数 |
totalPage | int | 总页数 |
content | struct[] | 当前页内容 |
Response data content的子对象结构体:
Name | Type | Description |
---|---|---|
created | long | 创建时间 |
description | string | 描述 |
adminState | int | 启用状态,0-禁用,1-启用,2-用户禁用 |
apiKey | string | 设备key |
connectGatewayId | string | 当前连接的边缘节点 |
encrypt | boolean | 是否加密,0:不加密,1:加密 |
name | string | 设备名 |
labels | string[] | 产品标签 |
id | int | 设备ID |
lastConnected | long | 最近上线时间 |
lastReported | long | 最近上报状态的时间 |
location | string | 位置 |
modified | long | 修改时间 |
operatingState | int | 在线状态(-1:无在线状态 / 0:离线 / 1:设备在线 / 2:网关在线 / 3:未激活) |
parentId | int | 关联边缘节点ID |
userId | string | 用户ID |
protocolType | int | 协议类型,1:MQTT,2:LWM2M,3:TCP,4:Modbus,5:OPC UA |
productId | int | 产品ID |
Response example:
{
"data": {
"currentPage": 1,
"pageSize": 5,
"totalCount": 13,
"totalPage": 3,
"content": [
{
"id": 10000246,
"name": "bqqr",
"userId": null,
"productId": 100048,
"created": 1568799603921,
"modified": 1568799603921,
"description": "string22",
"adminState": 1,
"operatingState": 0,
"labels": null,
"lastConnected": 0,
"lastReported": 0,
"location": null,
"apiKey": "OTE0NDcyYmYwZjkxZTk1NTNmN2E=",
"protocolType": 4,
"connectGatewayId": "0",
"encrypt": false
},
{
"id": 10000244,
"name": "b67rr",
"userId": null,
"productId": 100048,
"created": 1568798437978,
"modified": 1568798437978,
"description": "string22",
"adminState": 1,
"operatingState": 0,
"labels": null,
"lastConnected": 0,
"lastReported": 0,
"location": null,
"apiKey": "OWFhMTAxOGRjMGU1YjBmNzc2NGY=",
"protocolType": 4,
"connectGatewayId": "0",
"encrypt": false
},
{
"id": 10000243,
"name": "13eqqd",
"userId": null,
"productId": 100048,
"created": 1568797352371,
"modified": 1568797352371,
"description": "string22",
"adminState": 1,
"operatingState": 0,
"labels": null,
"lastConnected": 0,
"lastReported": 0,
"location": null,
"apiKey": "ODlhMjgyOTJkMWZmZjA3OWE4MzE=",
"protocolType": 4,
"connectGatewayId": "0",
"encrypt": false
},
{
"id": 10000237,
"name": "13242986666222",
"userId": null,
"productId": 100048,
"created": 1568796141212,
"modified": 1568796141212,
"description": "string22",
"adminState": 1,
"operatingState": 0,
"labels": null,
"lastConnected": 0,
"lastReported": 0,
"location": null,
"apiKey": "YzVkYTE2ZTBjMGQ1NmRlY2I2NmM=",
"protocolType": 4,
"connectGatewayId": "0",
"encrypt": false
}
]
},
"success": true,
"code": 0,
"msg": null
}
功能描述:根据节点ID、节点组ID,查询边缘节点的功能列表。
GET /api/v1/edgenode/pro/properties
cURL example:
curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/edgenode/pro/properties?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}'
Response data:
Name | Type | Description |
---|---|---|
data | struct[] | 当前页内容 |
Response data content的子对象结构体:
Name | Type | Description |
---|---|---|
id | int | 属性ID |
userId | string | 用户ID |
productId | int | 产品ID |
name | string | 属性名称 |
nodeName | string | 节点名称 |
identifier | string | 属性名称 |
accessMode | int | 属性读写类型,只读(1),读写(2),执行(3) |
type | int | 属性类型 |
unit | string | 属性单位 |
minimum | number | 参数最小值(数值类型特有) |
maximum | number | 参数最大值(数值类型特有) |
minString | string | 参数最小值(数值类型特有) |
maxString | string | 参数最大值(数值类型特有) |
special | struct[] | 对部分type的补充说明 |
required | int | 是否必须 |
kind | int | 功能分类(1:标准/2:自定义) |
class | int | 功能种类 (1:属性/2:事件) |
content special的子对象结构体:
Name | Type | Description |
---|---|---|
length | int | string类型的字符串长度,1-2048 |
enumArray | struct[] | 枚举和布尔类型的说明 |
special enumArray的子对象结构体:
Name | Type | Description |
---|---|---|
describe | string | 值对应的说明 |
key | int | 枚举和布尔类型的值 |
Response example:
{
"code": 0,
"data": [
{
"nodeName": "",
"identifier": "cpu.used",
"productId": 0,
"minString": null,
"kind": 0,
"accessMode": 1,
"type": 6,
"userId": null,
"maxString": null,
"required": false,
"special": {
"length": null,
"step": null,
"enumArray": null
},
"unit": "",
"name": "CPU使用率",
"maximum": 1,
"id": 0,
"minimum": 0,
"class": 0
},
{
"nodeName": "",
"identifier": "mem.used",
"productId": 0,
"minString": null,
"kind": 0,
"accessMode": 1,
"type": 6,
"userId": null,
"maxString": null,
"required": false,
"special": {
"length": null,
"step": null,
"enumArray": null
},
"unit": "",
"name": "内存使用率",
"maximum": 1,
"id": 0,
"minimum": 0,
"class": 0
},
{
"nodeName": "",
"identifier": "disk.used",
"productId": 0,
"minString": null,
"kind": 0,
"accessMode": 1,
"type": 6,
"userId": null,
"maxString": null,
"required": false,
"special": {
"length": null,
"step": null,
"enumArray": null
},
"unit": "",
"name": "磁盘使用率",
"maximum": 1,
"id": 0,
"minimum": 0,
"class": 0
}
],
"msg": "成功",
"success": true
}